Forum des exercices du projet Zuul

7.10.1

  
 
Avatar anonfirstname2 anonlastname2
7.10.1
par anonfirstname2 anonlastname2, mercredi 18 novembre 2020, 09:54
 

S'assurer que chaque classe et chaque méthode a son commentaire javadoc (bien placé), sinon compléter.

Passez cet exercice si vous êtes en présence d'un intervenant ; il vaut mieux faire un exercice nécessitant de la programmation Java et pouvoir bénéficier de son aide.

Mais n'oubliez pas d'y revenir après en travail personnel !

Avatar Thibaut TRASSART
Re: 7.10.1
par Thibaut TRASSART, mardi 10 mars 2015, 19:24
 

Est-ce normal que les méthodes privées ne soit pas visibles dans la javadoc ?

Avatar Denis BUREAU
Re: 7.10.1
par Denis BUREAU, mardi 10 mars 2015, 20:07
 

Oui, la javadoc expose ce qui est utilisable à l'extérieur de la classe, pour celui qui n'a pas accès au code java de cette classe.
Le but n'est pas de savoir comment la classe est programmée (attributs, méthodes privées), mais juste de pouvoir se servir de toutes les possibilités qu'offre cette classe.

(malgré tout, il est possible de générer une javadoc pour programmeur, ce que vous verrez à l'exercice 7.26.1)

Avatar Rubben SELLEM
Re: 7.10.1
par Rubben SELLEM, mardi 17 mars 2015, 09:12
 

Bonjour,

je ne comprend pas comment nous pouvons modifier la javadoc.

Est-ce simplement ajouter des commentaires pour chaque méthodes, ou faut-il faire quelque chose de plus précis ?


Avatar Denis BUREAU
Re: 7.10.1
par Denis BUREAU, vendredi 9 février 2018, 22:54
 

Après avoir commenté chaque méthode, vous devez (re)générer la documentation du projet.

BlueJ vous le permet dans le menu Tools/Project Documentation.

Avatar Denis BUREAU
Re: 7.10.1
par Denis BUREAU, mercredi 18 novembre 2020, 09:55
 

Un étudiant a écrit :

J'ai beaucoup de "warning: no @param for pQqch".
En cherchant sur Internet, j'avais l'impression qu'il fallait, dans les /**en-tête*/ de toutes les méthodes, écrire des "@param pQqch".
Je n'en suis pas sûre du tout, et n'en vois toujours pas l'utilité...

Avatar Denis BUREAU
Re: 7.10.1
par Denis BUREAU, mercredi 18 novembre 2020, 09:58
 

Il est utile d'expliquer dans la javadoc à quoi sert chaque paramètre d'une méthode.
Cela se fait par une ligne @param pNomParamètre explication du rôle de ce paramètre pour chaque paramètre de chaque méthode.